<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class YahooSessionStore</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Interface_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle">Interface YahooSessionStore</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The session store interface. own session store implementations and pass them to YahooSession::hasSession, YahooSession::requireSession and YahooSession::clearSession.</p>
<p class="description"><p>The session store interface. Developers are free to implement their own session store implementations and pass them to YahooSession::hasSession, YahooSession::requireSession and YahooSession::clearSession.</p></p>
		<p class="notes">
			Located in <a class="field" href="_YahooSessionStore.inc.html">/YahooSessionStore.inc</a> (line <span class="field"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a60">60</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#clearAccessToken" title="details" class="method-name">clearAccessToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#clearRequestToken" title="details" class="method-name">clearRequestToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#fetchAccessToken" title="details" class="method-name">fetchAccessToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">The</span>
										<a href="#fetchRequestToken" title="details" class="method-name">fetchRequestToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#hasAccessToken" title="details" class="method-name">hasAccessToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#hasRequestToken" title="details" class="method-name">hasRequestToken</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#storeAccessToken" title="details" class="method-name">storeAccessToken</a>
											(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">True</span>
										<a href="#storeRequestToken" title="details" class="method-name">storeRequestToken</a>
											(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
													<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodclearAccessToken" id="clearAccessToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">clearAccessToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a119">119</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears the access token from the session store.</p>
<p class="description"><p>Clears the access token from the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> on success, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			clearAccessToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodclearRequestToken" id="clearRequestToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">clearRequestToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a96">96</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears the request token from the session store.</p>
<p class="description"><p>Clears the request token from the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> on success, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			clearRequestToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfetchAccessToken" id="fetchAccessToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">fetchAccessToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a112">112</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetches and returns the access token from the session store.</p>
<p class="description"><p>Fetches and returns the access token from the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> access token.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			fetchAccessToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfetchRequestToken" id="fetchRequestToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">fetchRequestToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a89">89</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetches and returns the request token from the session store.</p>
<p class="description"><p>Fetches and returns the request token from the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> request token.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			fetchRequestToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodhasAccessToken" id="hasAccessToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">hasAccessToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a73">73</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates if the session store has an access token.</p>
<p class="description"><p>Indicates if the session store has an access token.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> if an access token is present, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			hasAccessToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodhasRequestToken" id="hasRequestToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">hasRequestToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a66">66</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicates if the session store has a request token.</p>
<p class="description"><p>Indicates if the session store has a request token.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> if a request token is present, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			hasRequestToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodstoreAccessToken" id="storeAccessToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">storeAccessToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a105">105</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores the given access token in the session store.</p>
<p class="description"><p>Stores the given access token in the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> on success, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			storeAccessToken
		</span>
					(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$token</span>
				<span class="var-name">$token</span><span class="var-description">: A PHP stdclass object containing the components of               the OAuth access token.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodstoreRequestToken" id="storeRequestToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">storeRequestToken</span> (line <span class="line-number"><a href="../__filesource/fsource_yos-social-php__YahooSessionStore.inc.html#a82">82</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores the given request token in the session store.</p>
<p class="description"><p>Stores the given request token in the session store.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> on success, false otherwise.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">True</span>
		<span class="method-name">
			storeRequestToken
		</span>
					(<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$token</span>
				<span class="var-name">$token</span><span class="var-description">: A PHP stdclass object containing the components of               the OAuth request token.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 22 Oct 2009 12:54:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>